Add inline code comments on commits (#4898) #35589

ktamas77 · 2025-10-05T19:16:10Z

Summary

This PR implements inline code comments on individual commits, similar to the existing PR code review functionality.

Features

✅ Add inline comments on any line of a commit diff
✅ Edit and delete your own comments
✅ Attachment support
✅ @mention notifications
✅ Works in both unified and split diff views

Implementation Details

Reuses existing Comment model infrastructure (CommitSHA, Line, TreePath already supported)
New service layer for commit comment CRUD operations
API routes: /commit/:sha/comments for create/update/delete
Templates updated to show comment UI when PageIsCommit is true
Existing PR comment JavaScript handles commit comments generically

Testing

✅ Builds successfully without errors
Backend implementation follows existing PR comment patterns
Reuses PR comment templates and JavaScript

Fixes #4898

/claim #4898

This feature enables users to add inline code comments on individual commits, similar to the existing PR code review functionality. Comments can be added, edited, and deleted on any line of a commit's diff. Changes: - Add service layer functions for commit comment CRUD operations - Add router handlers and API routes for commit comments - Add model queries to find commit comments - Update diff templates to show comment UI on commit pages - Load and display commit comments in the Diff() handler - Reuse existing PR comment templates and JavaScript Implements: #4898

lunny · 2025-10-06T00:35:32Z

I don't think the comment type CommentTypeCode should be reused here.

Instead of reusing CommentTypeCode (which is for PR code comments), introduce a new CommentTypeCommitCode type specifically for inline comments on commits. This provides better separation of concerns and makes the codebase more maintainable. Changes: - Add CommentTypeCommitCode constant and string representation - Update comment type methods to support the new type - Update all commit comment functions to use CommentTypeCommitCode - Handle commit comments separately in updateCommentInfos

ktamas77 · 2025-10-06T00:54:24Z

I don't think the comment type CommentTypeCode should be reused here.

Good point! I've updated the implementation to use a separate CommentTypeCommitCode type instead of reusing CommentTypeCode. This provides better separation between PR code comments and commit inline comments. All the related functions and methods have been updated accordingly.

lunny · 2025-10-19T05:15:34Z

models/issues/comment.go

 }

+// FindCommitComments finds all code comments for a specific commit
+func FindCommitComments(ctx context.Context, repoID int64, commitSHA string) (CommentList, error) {


Is there an index for the query?

Currently there's an index on type but not on commit_sha. This function would benefit from an index on commit_sha (or a composite index on (commit_sha, type)) since it queries by that field directly. Should I add one in a migration?

lunny · 2025-10-19T05:16:24Z

models/issues/comment.go

+}
+
+// FindCommitLineComments finds code comments for a specific file and line in a commit
+func FindCommitLineComments(ctx context.Context, commitSHA, treePath string) (CommentList, error) {


It's better to filter by tree path and line in the memory otherwise, we need a new index for the database.

I've updated FindCommitLineComments to filter by tree path in memory instead of in the database query, avoiding the need for a new index on tree_path. However, both this function and FindCommitComments would still benefit from an index on commit_sha since they query by that field.

I think we need a new composite index repo_id and commit_sha and the issue_id should be zero. Because it maybe conflicted with a pull request's commit_sha.

Currently the Comment table doesn't have a repo_id field. To implement this, I would need to:

Add a repo_id column to the comment table (migration)

Create a composite index on (repo_id, commit_sha)

Ensure issue_id = 0 for standalone commit comments

Update CreateComment to populate repo_id

Update FindCommitComments and FindCommitLineComments to filter by repo_id

Should I proceed with creating this migration?

Filter by tree path in memory instead of in database query to avoid requiring a new database index. This improves performance by using existing indexes on commit_sha and type.

lunny · 2025-10-19T17:57:45Z

models/issues/comment.go

+func FindCommitComments(ctx context.Context, repoID int64, commitSHA string) (CommentList, error) {
+	comments := make([]*Comment, 0, 10)
+	return comments, db.GetEngine(ctx).
+		Where("commit_sha = ?", commitSHA).


repo_id was missed.

Good catch! Currently, commit comments don't have a repo_id field in the table - they only store commit_sha. This means we can't filter by repository in the current schema.

We have a few options:

Add a repo_id field to the comment table (requires migration)

Remove the repoID parameter since it can't be used

Accept that the same commit_sha across forks would show all comments

What would you prefer?

3. Accept that the same commit_sha across forks would show all comments

I don't think this is accepted. So that I think repo_id is a MUST. Maybe we can have a new table for commit_comment which have a repo_id and a comment_id. So that we don't need to add a new column for comment table.

Sounds good - a separate commit_comment table would be cleaner. So the structure would be:

New commit_comment table:

id (pk)

repo_id (indexed)

comment_id (indexed, foreign key to comment.id)

commit_sha (indexed)

Composite index on (repo_id, commit_sha)

Then when querying, we'd join with this table to filter by repo. This keeps the comment table unchanged and makes the commit-specific metadata explicit.

Should I proceed with implementing this approach?

Sounds better than before. But I don't know wether it could be accepted by other @go-gitea/maintainers .

I see - this is a deeper architectural issue. The attachment system expects bindings to issues/releases, so commit comment attachments (without issue_id) would be incorrectly deleted as orphaned.

Given the complexity here, I'll wait for maintainer consensus on the best approach before proceeding. Please tag me when there's a decision on how to handle this properly.

@delvh Dude....

I'm out. Solve it for yourself

Sorry for the misunderstanding. Maybe some messages read too like "vibe coding" and there were a lot of AI PRs from other contributors 🤣 Apologize again.

By the way I am not a native speaker, so please point out if my comment doesn't read good.

By your analysis, I think I can see a potential feasible approach now, although not completely clear yet, share some points:

The repo_id is still necessary, I think only the commit comments from origin repo can be edited or replied.

Adding a new commit_comment table seems the only solution . I don't think Comment.CommitSHA can be reused since it is use for "CommentTypeCommitRef" and there is no index and it's not suitable to add an index for it

DeleteOrphanedAttachments should be updated to respect "comment_id"

How to "reply" a comment? Maybe commit_comment.parent_comment_id?

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Oct 5, 2025

algora-pbc bot added the 🙋 Bounty claim label Oct 5, 2025

algora-pbc bot mentioned this pull request Oct 5, 2025

Add inline comments on commits #4898

Open

github-actions bot added modifies/go Pull requests that update Go code modifies/templates This PR modifies the template files labels Oct 5, 2025

ktamas77 force-pushed the feature/commit-inline-comments branch from dfbfd56 to a706a04 Compare October 5, 2025 19:47

lunny reviewed Oct 19, 2025

View reviewed changes

Optimize FindCommitLineComments to filter in memory

aeafe3d

Filter by tree path in memory instead of in database query to avoid requiring a new database index. This improves performance by using existing indexes on commit_sha and type.

lunny reviewed Oct 19, 2025

View reviewed changes

ktamas77 closed this by deleting the head repository Oct 20, 2025

Uh oh!

Add inline code comments on commits (#4898) #35589

Add inline code comments on commits (#4898) #35589

Conversation

ktamas77 commented Oct 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Features

Implementation Details

Testing

Uh oh!

lunny commented Oct 6, 2025

Uh oh!

ktamas77 commented Oct 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ktamas77 Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ktamas77 Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wxiaoguang Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ktamas77 commented Oct 5, 2025 •

edited

Loading

ktamas77 Oct 19, 2025 •

edited

Loading

ktamas77 Oct 19, 2025 •

edited

Loading

wxiaoguang Oct 20, 2025 •

edited

Loading